Configuring Analytic outputs
The selected Analytic will specify the outputs of the algorithm. All Analytic outputs are automatically generated as output fields in the port. These need to be mapped to Proficy CSense fields required by other blocks in the Architect blueprint. As such, the OSA-CBM data types produced by the output data from the Analytic module are mapped to user-created Proficy CSense fields in the output port.
Proficy CSense output fields can be auto generated from the Analytic output data. When there is no logical data type mapping to one of the Proficy CSense field types, the Analytic output is converted to a string data type, and a single Proficy CSense string field in the output port is created. The string contents should be compliant with the OSA-CBM XML.
Requirements of output fields
-
Field names must be unique
-
Field names are not case sensitive.
-
There will be a default "Success" field defined as an integer output field
-
-
This is a 0-1 based flag and it's value will be set after the Analytic module is executed to indicate whether the execution was successful or not.
-
"Success" is a reserved keyword for this block, which implies you are not allowed to create (manually or auto-generated) an output field called "Success".
-
You cannot delete or map to the "Success" field.
-
Mapping output fields
The grid is the Analytic output mapping grid.
Analytics outputs
-
Name: OSA-CBM output fields, stipulated in the Analytic
-
Data type: OSA-CBM data type, defined by the Analytic
-
Output name: the Proficy CSense fields that are mapped to the OSA-CBM fields
-
Output type: the Proficy CSense data type of the fields that is mapped.
Multiplicity in analytics outputs
The analytics block supports analytics with multiple occurrences of single analytic output field (It functions like array type). The is determined by a variable flag in the analytic template by the publisher of the Analytic.
-
When variable flag is false, then there will be one output field mapped for each required Analytic output. There is no [+] or [-] expander buttons in the first column.
-
When the variable flag is true, then there can be more than one output field mapped for each required Analytic output.
-
-
- The row on the Outputs tab grid will show a parent – child relationship
- The parent row 1st column has a [+] or [-] expander button to open or close the child grid. The parent row will have the
button to add more child rows. - The parent row itself cannot be mapped. Mapping happens with the child rows, even if there is only 1 child row.
- The child rows will have the same columns as the parent row. The Field column can be mapped.
- You can continue adding more output fields until the expander button is no longer visible. This means you have reached the defined maximum number of rows that can all be mapped to the same Analytic output. Delete one or more child rows to enable the again, and add more child rows.
- The child row has a
button column at the end of the row - use this to delete the row. - Delete each child row, if required, until the minimum occurrence limit is reached. After this, no more child rows can be deleted.
-
Note: Changing the number of occurrences of analytic output fields does not change the block outputs. They still need to be mapped to be shown on the output port.
Related topics: